Add Contribution Guide for PR Process and Lint Test in GitHub Actions #615
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @nightohl, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
This pull request addresses the need to prevent ESLint errors from being missed during the review process, as highlighted by the merging of a previous feature branch that contained such errors. To achieve this, I've made changes to both the contribution guide and the GitHub Actions workflow. Specifically, I've updated the contributing.md file to include a section on pre-pull request checks, which instructs contributors to run linting, tests, and build commands locally before submitting a PR. Additionally, I've modified the test.yml GitHub Actions workflow to include a linting check as part of the CI process.
Highlights
- Contribution Guide Update: I've added a 'Before Pull Request' section to
contributing.md, detailing the steps contributors should take to ensure code quality, including running linting, tests, and build commands. - GitHub Actions Workflow Enhancement: I've updated the
test.ymlworkflow to include a linting check (pnpm run test:lint) to automatically catch ESLint errors during CI.
Changelog
- .github/workflows/test.yml
- Added a new job step to run linting using
pnpm run test:lintbefore running tests.
- Added a new job step to run linting using
- contributing.md
- Added a new section 'Before Pull Request' that instructs contributors to run linting, tests, and build commands locally before submitting a pull request.
- Added specific commands for linting (
pnpm run test:lint), testing (pnpm test), and building (pnpm build).
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Did you know?
Linters can automatically fix certain types of code style issues, such as indentation and spacing, making code more consistent and readable.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces a lint check to the GitHub Actions workflow and updates the contributing guide to include linting, testing, and building steps before submitting a pull request. This is a good proactive measure to prevent ESLint errors from being missed during the review process. The changes are straightforward and address the issue effectively.
Merge Readiness
The changes are well-structured and address the problem effectively. I recommend merging this pull request after ensuring that the new lint check in the GitHub Actions workflow is functioning as expected. I am unable to directly approve the pull request, and recommend that others review and approve this code before merging.
nightohl
force-pushed
the
test-eslint-before-merge
branch
from
8ac4f51 to
a2e2b3d
Compare
|
@transitive-bullshit |
|
I just didn't run the tests before merging the other PRs. |
|
@transitive-bullshit |
Description
We’ve merged the #604 feature into the master branch, but unfortunately, an ESLint error was overlooked during the review process. The issue was addressed and fixed in PR #614.
To prevent similar situations in the future, I would like to suggest updating the contribution guide and GitHub Actions for PRs to include an automated lint check.
Notion Test Page ID